feat(storybook): Remove consideration of mjs from docgen plugin #11346
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Let me try this PR locally, see if that fixed the issue in LeftLane |
Josh-Walker-GM
added
release:fix
dac09
added a commit
to dac09/redwood
that referenced
this pull request
Aug 26, 2024
…into feat/rw-uploads-extension * 'feat/rw-uploads-extension' of github.com:dac09/redwood: (22 commits) fix(jobs): Type-safe arguments passing to jobs from scheduler (redwoodjs#11371) chore(jobs tests): String literal array for queues (redwoodjs#11370) feat(jobs): Expose types (redwoodjs#11369) fix(template): Set scripts/ module resolution to match api/ (redwoodjs#11366) fix(template): Format tsconfig and jsconfig (redwoodjs#11365) fix(tsconfig): set "module" to "ESNext" for web/tsconfig.json (redwoodjs#11368) fix(cli): Fix tests generated by `g cell` (redwoodjs#11364) chore(deps): bump micromatch to 4.0.8 (redwoodjs#11362) chore(deps): bump micromatch to 4.0.8 in create-redwood-rsc-app (redwoodjs#11363) Adds docs for how to do recurring jobs (redwoodjs#11361) Adds docs for jobs setup and generate commands (redwoodjs#11359) feat(storybook): Remove consideration of mjs from docgen plugin (redwoodjs#11346) chore(deps): bump micromatch from 4.0.5 to 4.0.8 in /docs (redwoodjs#11358) chore(tarsync): Add watch mode to project:tarsync (redwoodjs#11347) chore(docs): Move content to main so we can deploy from that branch (redwoodjs#11356) chore(jobs test): Remove unused file. Use toContain() (redwoodjs#11355) chore(listr2mock): Move comments closer to referenced code (redwoodjs#11354) chore(listr2mock): Improve types and make it more capable (redwoodjs#11352) chore(jobs): Add e2e test script and CI job (redwoodjs#11348) chore(cli tests): Fix include glob (redwoodjs#11351) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We created out Storybook framework package by starting with the official framework package for React Vite.
Included in this is a Vite plugin for React Docgen, which is used by Storybook to know what the "controls" are (aka props) for a given component.
This is simply a QOL thing —
With docgen:
Without docgen:
With or without docgen, in order to be able to have interactive controls, you still need to configure them.
Docgen is mostly just used for automatic argType inference.
The docgen plugin that we originally included in our framework package matches components in
mjs,tsx, andjsxfiles.tsxandjsxare obvious requirements, and we didn't give any additional thought to the inclusion ofmjs, though it now seems that if you do have any.mjsfiles that aren't components, it'll completely break your ability to load stories, as discovered by @simoncrypta.Therefore, this PR simply removes the inclusion of those files.